Skip to main content

New Serialized Fulfillment GraphQL APIs

πŸ“ Important: This feature is currently in Preview status. For more information about Preview status, see the GraphQL API policy.

The GraphQL API supports a Serialized Fulfillment system that can track individually identified items within a shipment of physical products.

This allows marketplace owners to identify individual items in the process of fulfillment, which aids managing the lifecycle of non-fungible items – for example, when items in a shipment come with a warranty, or when a particular policy applies to them regarding replacements or returns.

Each serialized item must have a primary identifier and a type, and may optionally have a secondary identifier. The type may be one of the following:

  • IMEI
  • ICCID
  • Serial
  • Other

The following query is available:

serializedUnitsByShipmentItemId – Returns a list of serialized units for an item within a shipment.

The following mutations are available:

createSerializedUnitsForShipment – Creates a list of serialized units for a shipping item in a shipment.

deleteSerializedUnitsForShipment – Deletes a list of serialized units.

This new set of APIs complements the existing Inventory APIs.

Feature enablement

No feature enablement is required.

Setting enablement

No setting enablement required.

Documentation

The GraphQL API reference documentation will be updated with the release. The user documentation will be updated with a future release.

Was this page helpful?